home *** CD-ROM | disk | FTP | other *** search
/ TPUG - Toronto PET Users Group / TPUG Users Group CD / TPUG Users Group CD.iso / AMIGA / (A)TB / (A)TBT.ADF / CustomHelp / CHmanual / Start.ch < prev    next >
Text File  |  1991-11-21  |  5KB  |  147 lines
  1. \pm Custom Help \ Starting and Termination
  2. \p Starting and Termination \ Starting Program
  3.  
  4.  
  5.     To run from the CLI or a script put all of the Data Files\
  6. and Auxiliary Files in\
  7. their own directory (hereinafter simply called the CH Directory),\
  8. then assign the name "CHData:" to that directory using the Command\
  9. "Assign CHData: DIRECTORY" where DIRECTORY is the full path name of\
  10. the directory containing the Data Files. Put the "CH" program file\
  11. into the C: directory.
  12.  
  13.     To run from WorkBench open the CustomHelp drawer and double click\
  14. the CH program icon.
  15.  
  16.     CH requires the files CH.cmd and CH.prefs for it's Command configuration\
  17. and preferences respectively. When started it will look for these\
  18. files in the CH Directory. If either file can not be found in the\
  19. proper directory the program will terminate immediately.
  20.  
  21.     The optional file, CH.menu, defines the menus. Menus are not necessary
  22. for program operation. This file, if used, must also be in the CH Directory.
  23.  
  24.     Most program options are set at startup from the CH.prefs File.\
  25. If any Startup Option is used, it will override the value taken from\
  26. the CH.prefs File. All of the of the other options may be changed during\
  27. program execution. To make the changes\
  28. permanent, choose "SAVE" on the User Input Window where the option appears, or\
  29. execute the Save Preferences Instruction. These changes will be saved in the\
  30. CH.prefs file and used the next time the program is started.
  31.  
  32.     CH is started from the CLI with the Command "CH". CH runs\
  33. as a background task, so it is not necessary\
  34. to "run" the program. On startup, the program will look for any file matching\
  35. the "Base.#?" pattern in the CH Directory. These files will be opened\
  36. and a Base Page will be built.
  37.  
  38.     CH is started from WorkBench by clicking on the program icon. Use\
  39. the "info" WorkBench menu item to alter the Startup Options.
  40.  
  41.     The startup message will tell you the configured Hot Key and Qualifier.
  42.  
  43. \r\Files/CH.prefs File
  44. \r\Files/CH.cmd File
  45. \r\Files/CH.menu File
  46. \p Startup Options
  47.  
  48.  
  49.     The Startup Options consist of the Command line switches, if started\
  50. from the CLI, or the Tool Types array, if started from the WorkBench Screen.
  51.  
  52.     Although you are not required to specify a WorkBench Output Window, be aware\
  53. that if you run CH from WorkBench without an output window, there will\
  54. be no indication that the program has started.
  55.  
  56.     Startup Options have precedence over the CH.prefs File values.\
  57. Options are provided to set the\
  58. Hot Key, Hot Key Qualifiers, CH Directory and WorkBench Output\
  59. Window.
  60.  
  61.     Each option must be given with the option name or first letter,\
  62. an equals sign "=", then the option value or values, with no\
  63. intervening spaces.
  64.  
  65. Hot Key Option:
  66. \l3    This may be set to any\
  67. key on the keyboard except the qualifier keys (Control, Shift, etc.).
  68.  
  69.     If the key you wish to use is one of the normally printable keys,\
  70. specify it with the character itself.\
  71. The normally printable keys are those that print a single character,\
  72. without the qualifiers Alternate or Control.\
  73. Case is insignificant for the key specified.\
  74. If you want an upper case letter specify a shift for the qualifier rather\
  75. than an upper case letter. Numeric keys specified by this method will\
  76. default to the top row of numeric keys on the keyboard rather than the\
  77. numeric keypad on the right hand side.
  78.  
  79.     If you want to use one of the\
  80. non-printable keys (BACKSPACE, DELETE, etc.) or the numeric keypad keys,\
  81. select a key name from the\
  82. list below. You may enter just enough of the name to completely distinguish the\
  83. it from all of the others. For the DELETE key, DEL is enough.
  84. \w
  85. \l6    Key Names:
  86.         Function Keys --  F1, F2, F3, F4, F5, F6, F7, F8, F9, F10
  87.         Numeric Keypad -- KP0, KP1, KP2, KP3, KP4,
  88.                                 KP5, KP6, KP7, KP8, KP9,
  89.                                 KP(, KP), KP/, KP*, KP-, KP+, KP., ENTER
  90.         Arrow Keys --     UP, DOWN, LEFT, RIGHT
  91.         Others --         SPACE, BACKSPACE, TAB, ESCAPE, DELETE,
  92.                                 HELP, RETURN
  93.  
  94. Examples:
  95.         "KEY=a" for the 'a' key
  96.         "K=/" for the '/' key
  97.         "KEY=ESCAPE"
  98.         "K=KP5"
  99. \W
  100. \l
  101. Hot Key Qualifier:
  102. \l3    This may be any\
  103. combination of the Shift, Alternate and Control qualifier keys.\
  104. If using Shift or Alternate, specify the left or right key.\
  105. When using multiple qualifiers, seperate each qualifier by a dash "-".\
  106. The qualifier names listed below may be abbreviated to the first\
  107. one or two letters, enough to distinguish the name from all of the others.
  108.  
  109. \l        Use:
  110.             "LShift" = Left Shift
  111.             "RShift" = Right Shift
  112.             "LAlternate" = Left Alternate
  113.             "RAlternate" = Right Alternate
  114.             "Control" = Control
  115.             
  116. \l6Examples:
  117.         "Q=LShift-Control"
  118.         "QUALIFIERS=RA-C" specifys the RightAlternate-Control keys.
  119.         "Q=C" for Control key
  120. \l
  121. CH Directory:
  122. \l3    The default is the "CHData:" directory, if assigned, the current\
  123. directory if not. If an alternate\
  124. CH Directory is desired use this option to specify the new directory.
  125.  
  126. \l6Examples:
  127.         "DIRECTORY=dirname"
  128.         "D=dirname"
  129. \l
  130. WorkBench Output Window:
  131. \l3    If starting from WorkBench, an output window may be specified to\
  132. receive any messages that would normally go to the CLI.\
  133. You may specify any size, position (within the bounds of the WorkBench\
  134. Screen) and window title desired.
  135.  
  136. \l6Examples:
  137.         "WINDOW=NO" for no output window.
  138.         "W=NO"
  139.         "WINDOW=CON:0/0/500/50/Custom Help" for an output\
  140. window at location 0, 0 with a size of 500 x 50 and the title "Custom Help".
  141.  
  142. \p Terminate Program
  143.  
  144.  
  145.     Open the DW and execute the Terminate Program Instruction.
  146.  
  147.